Skip to main content
Feedback

Metrics

Supported operations

OperationQUERYMUTATION
EventStreamsTopicMetrics✅ SupportedNot Supported 
EventStreamsSubscriptionMetrics✅ SupportedNot Supported 

Topics metrics query syntax

Event Streams Topic Metrics summary

eventStreamsTopicMetricsSummary ( input EventStreamsMetricsQueryInput! ) [EventStreamsTopicMetrics!]

EventStreamsTopicMetrics

{
  eventStreamsTopicMetricsSummary(input: {
  requestTsStart: "2023-09-06"
  requestTsEnd: "2023-09-26"
  requestTsInterval: {
    amount: 1
    unit: DAYS
  }
}) {
    region
    account {
      id
      name
      status
      settings
      eventStreams
    }
    environment {
      id
      name
      gateway
      settings
      publishedName
      classification
      integrationPackEnvironmentAttachment
      atoms
      eventStreams
    }
    topic {
      name
    }
    subscriptionCount
    producerCount
    consumerCount
    messageRateIn
    messageRateOut
    backlog
    inMessagesTotal
    intervalStartTs
    intervalEndTs
  }
}

Topics metrics query fields

FieldTypeDescription
regionstringThe name of the region to which the topic belongs.
accountAccountThe account to which the topic belongs.
environmentEnvironmentThe environment to which the topic belongs.
topicEventStreamsQueryTopicThe details of the topic. It is unique within the environment.
subscriptionCountIntegerThe last value of the number of subscriptions on this topic in the given time range.
producerCountIntegerThe last value of the number of active producers on this topic in the given time range.
consumerCountIntegerThe last value of the number of active consumers on this topic in the given time range.
messageRateInFloatThe average rate of the messages produced per second on this topic in the given time range.
messageRateOutFloatThe average rate of the messages consumed per second from this topic in the given time range.
backlogBigIngegerThe total number of messages for all subscriptions not acknowledged on this topic in the given time range.
inMessagesTotalBigIntegerThe total number of messages received for this topic since inception.
intervalStartTsDateTimeThe date and time of the start of the interval.
intervalEndTsDateTimeThe date and time of the end of the interval.
deadLetterBacklogBigIntegerThe total number of dead letter messages for all subscriptions on this topic in the given time range.

EventStreamsQueryTopic

FieldTypeDescription
idIDThe name of the topic. It is unique within the environment.
environmentEventStreamsTopicMetrics.environmentThe environment to which the topic belongs.

Subscription metrics query syntax

Event Streams Subscription Metrics summary

eventStreamsSubscriptionMetricsSummary ( input EventStreamsMetricsQueryInput! ) [EventStreamsSubscriptionMetrics!]

EventStreamsSubscriptionMetrics

query subMetrics {
eventStreamsSubscriptionMetricsSummary(input: {
  requestTsStart: "2023-05-20"
  requestTsEnd: "2023-06-01"
  requestTsInterval: {
    amount: 1
    unit: DAYS
  }
}) {
    intervalStartTs
    backlog
    deadLetterBacklog
  }
}

Subscription metrics query fields

FieldTypeDescription
regionstringThe name of the region to which the subscription belongs.
accountAccountThe account to which the subscription belongs.
environmentEnvironmentThe environment to which the subscription belongs.
subscriptionEventStreamsQuerySubscriptionThe details of the subscription. It is unique within the environment.
backlogBigIngegerThe total number of messages not acknowledged on this subscription in the given time range.
messageRateOutFloatThe average rate of messages consumed per second on this subscription in the given time range.
messageThroughPutFloatThe average message consumption throughput per second on this subscription in the given time range.
outMessagesTotalBigIntegerThe total number of messages read from this subscriptions in the given time range.
intervalStartTsDateTimeThe date and time of the start of the interval.
intervalEndTsDateTimeThe date and time of the end of the interval.
deadLetterBacklogBigIntegerThe total number of dead letter messages on this subscription in the given time range.

EventStreamsQuerySubscription

FieldTypeDescription
idIDThe name of the subscription. It is unique within the topic.
topicEventStreamsQueryTopicThe environment to which the topic belongs.

EventStreamsMetricsQueryInput

FieldTypeDescription
requestTsStartDateTimeFilters the records retrieved to only those on or after this timestamp.
requestTsEndDateTimeFilters the records retrieved to only those on or before this timestamp.
filterFilterFilters the records retrieved using the Filter Query Language. The fields available in the filter expression are those listed in the EventStreamsTopicMetrics and EventStreamsSubscriptionMetrics type.

| |requestTsInterval|EventStreamsQueryTimeInterval|The time interval to bucket requested summary data for given timeunit and number of buckets.|

Free-form text following the filter query language syntax. This syntax is a set of conditions joined together with and or or keywords and optionally grouped by parentheses.

Each condition has the form:

<field_path> <operator> <literal>

OR

<field_path> in [ <literal>, <literal>, ... ]

OR

<field_path> not in [ <literal>, <literal>, ... ]

where

  • field_path is the period-separated chain of field names (see the description for the input field using thi scalar for more details).
  • operator is one of =, <=, >=, !=, <, or >.
  • literal is a number or text enclosed with quotes or double-quotes

For example:

`(field1 = 'abc' and field2 > 5.3) or (field3.subfieldA != "def"
and field4.subfieldB.subsubfieldZ in [ 200, 204, 205 ])`

Scalar Filter

FieldDescription
FILTER_INVALID_FIELDThe Filter Invalid Field exception is returned when the field ''{0}'' is not available at line {1}, character {2} of ''{3}''.
FILTER_INVALID_OPERATORThe Filter Invalid Operator exception is returned when the {} Operator ''{0}'' is not available at line {1}, character {2} of ''{3}''.
FILTER_INVALID_ENUM_VALUEThe Filter Invalid Enum Value is returned when the Enum value ''{0}'' is not available at line {1}, character {2} of ''{3}''.
FILTER_VALUE_NOT_COERCIBLEThe Filter Value Not Coercible is returned when the The value ''{0}'' is not able to be coerced to a {1} at line {2}, character {3} of ''{4}''.
FILTER_FIELD_NOT_SCALARThe Filter Field Not Scalar is returned when the field ''{0}'' cannot have a condition on it because it is not a scalar or enum at line {1}, character {2} of ''{3}''.
FILTER_INVALID_SYNTAXThe Filter Invalid Syntax is returned when the filter string does not follow proper syntax: {0}.

scalar DateTime

A date and time with up to millisecond granularity. Represented as either an ISO-8601 string or as the number of milliseconds past epoch (1970-01-01). Examples:

  • 2021-11-02T00:33:22.822Z
  • 1638826693664
  • 2021-11-20
  • 2021-11-02T11:38:47EDT
FieldTypeDescription
scalarLong64-bit signed integer. Represented as either an Int or a String of digits (123 or \"123\").
scalarBigIntegerA sized integer with no bounds. Represented as a string of digits or scientific notation.
scalarUploadEither a file in a multi-part request or an inline data URL.

|

GraphQL implementation

EventStreamsTopicsMetricsSummary Query

{
  eventStreamsTopicMetricsSummary(input: {
  requestTsStart: "2023-09-06"
  requestTsEnd: "2023-09-26"
  requestTsInterval: {
    amount: 1
    unit: DAYS
  }
}) {
    region
    account {
      id
      name
      status
      settings
      eventStreams
    }
    environment {
      id
      name
      gateway
      settings
      publishedName
      classification
      integrationPackEnvironmentAttachment
      atoms
      eventStreams
    }
    topic {
      name
    }
    subscriptionCount
    producerCount
    consumerCount
    messageRateIn
    messageRateOut
    backlog
    inMessagesTotal
    intervalStartTs
    intervalEndTs
  }
}

EventStreamsTopicsMetricsSummary Resonse

{
  "data": {
    "eventStreamsTopicMetricsSummary": [
      {
        "topic": {
          "name": "Test_Topic"
        },
        "subscriptionCount": 3,
        "producerCount": 0,
        "consumerCount": 0,
        "messageRateIn": 0,
        "messageRateOut": 0,
        "backlog": 0,
        "inMessagesTotal": 0,
        "intervalStartTs": "2023-07-22T00:00:00.000Z",
        "intervalEndTs": "2023-08-21T00:00:00.000Z"
      }
    ]
  }
}

EventStreamsSubscriptionMetricsSummary Query

{
  eventStreamsSubscriptionMetricsSummary(input: {
  requestTsStart: "2023-09-06"
  requestTsEnd: "2023-09-26"
  requestTsInterval: {
    amount: 1
    unit: DAYS
  }
}) {
    region
    account {
      id
      name
      status
      settings
      eventStreams
    }
    environment {
      id
      name
      gateway
      settings
      publishedName
      classification
      integrationPackEnvironmentAttachment
      atoms
      eventStreams
    }
    subscription {
      name
      topic
    }
    backlog
    messageRateOut
    messageThroughputOut
    outMessagesTotal
    intervalStartTs
    intervalEndTs
    deadLetterBacklog
  }
}

EventStreamsSubscriptionMetricsSummary Response

{
  "data": {
    "eventStreamsSubscriptionMetricsSummary": [
      {
        "subscription": {
          "name": "Test1"
        },
        "backlog": 0,
        "messageRateOut": 0,
        "messageThroughputOut": 0,
        "outMessagesTotal": 0,
        "intervalStartTs": "2023-08-17T00:00:00.000Z",
        "intervalEndTs": "2023-08-18T00:00:00.000Z",
        "deadLetterBacklog": null
      },
      {
        "subscription": {
          "name": "Test2"
        },
        "backlog": 0,
        "messageRateOut": 0,
        "messageThroughputOut": 0,
        "outMessagesTotal": 0,
        "intervalStartTs": "2023-08-17T00:00:00.000Z",
        "intervalEndTs": "2023-08-18T00:00:00.000Z",
        "deadLetterBacklog": null
      },
      {
        "subscription": {
          "name": "Test3"
        },
        "backlog": 0,
        "messageRateOut": 0,
        "messageThroughputOut": 0,
        "outMessagesTotal": 0,
        "intervalStartTs": "2023-08-17T00:00:00.000Z",
        "intervalEndTs": "2023-08-18T00:00:00.000Z",
        "deadLetterBacklog": null
      }
    ]
  }
}

On this Page